<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
		<title>Tuxxedo Engine API Documentation</title>

		<link rel="stylesheet" href="./style.css" media="all" type="text/css" />
	</head>
	<body>

<h1>\Tuxxedo\Session</h1>
<div class="box">
	<div class="inner">
		<div class="left-content">
			<fieldset>
				<legend><strong>Meta information</strong></legend>
				<table cellspacing="4" cellpadding="0">
					<tr>
						<td>Availability:</td>
						<td class="value" style="width: 100%">
							Tuxxedo Engine 1.0.0
						</td>
					</tr>
					<tr>
						<td>Type:</td>
						<td class="value" style="width: 100%">
							<a href="./classes.html">Class</a>
						</td>
					</tr>
					<tr>
	<td nowrap="nowrap">Namespace:</td>
	<td class="value" style="width: 100%" nowrap="nowrap">
		<a href="namespace-tuxxedo-167390.html">\Tuxxedo</a>
	</td>
</tr><tr>
	<td nowrap="nowrap">Declared in:</td>
	<td class="value" style="width: 100%" nowrap="nowrap">
		library/Tuxxedo/Session.php
	</td>
</tr><tr>
	<td nowrap="nowrap">Extends:</td>
	<td class="value" style="width: 100%" nowrap="nowrap">
		<a href="class-tuxxedodesigninfoaccess-346314.html">\Tuxxedo\Design\InfoAccess</a>
	</td>
</tr><tr>
	<td nowrap="nowrap">Implements:</td>
	<td class="value" style="width: 100%" nowrap="nowrap">
		<a href="interface-tuxxedodesigninvokable-208506.html">\Tuxxedo\Design\Invokable</a>
	</td>
</tr>
				</table>
			</fieldset>
		</div>
		<div class="content">
			<div class="infobox">
				Session interface, this class is designed to be attached to
classes that implements an interface based on sessions.
			</div>
			<br />
		</div>
		<div style="clear: left;"></div>
	</div>
</div>





<h2><span>Contents</span></h2>
<div class="box edge-title">
	<div class="inner">
		<div class="infobox">
			Table of contents
		</div>

		<h3>
	Properties
	<a name="properties"></a>
</h3>
<table style="width: 100%" cellspacing="2" cellpadding="0">
	<tr class="head">
		<td class="strong" nowrap="nowrap" style="width: 20%;">Property</td>
		<td class="strong">Description</td>
	</tr>
	<tr class="row">
	<td nowrap="nowrap"><a href="property-id-505778.html">$id</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Static</span>&nbsp;The session id</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="property-options-657128.html">$options</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Protected</span>&nbsp;<span class="tag">Static</span>&nbsp;The session options, such as prefix, path etc.</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="property-started-770728.html">$started</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Static</span>&nbsp;Whether a session is started or not</td>
</tr>
</table><h3>
	Methods
	<a name="methods"></a>
</h3>
<table style="width: 100%" cellspacing="2" cellpadding="0">
	<tr class="head">
		<td class="strong" nowrap="nowrap" style="width: 20%;">Method</td>
		<td class="strong">Description</td>
	</tr>
	<tr class="row">
	<td nowrap="nowrap"><a href="method-get-234576.html">get()</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Static</span>&nbsp;Gets a session variable</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-invoke-839583.html">invoke()</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Static</span>&nbsp;Magic method called when creating a new instance of the</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-offsetexists-150526.html">offsetExists()</a></td>
	<td nowrap="nowrap" style="width: 100%">Checks whether a session variable is available</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-offsetget-380300.html">offsetGet()</a></td>
	<td nowrap="nowrap" style="width: 100%">Gets a value from a session variable</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-offsetset-160173.html">offsetSet()</a></td>
	<td nowrap="nowrap" style="width: 100%">Sets a new session variable</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-offsetunset-832753.html">offsetUnset()</a></td>
	<td nowrap="nowrap" style="width: 100%">Deletes a session variable</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-regenerate-992093.html">regenerate()</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Static</span>&nbsp;Regenerates a new session ID, note that APIs that utilizes the</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-restart-854288.html">restart()</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Static</span>&nbsp;Restarts a session</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-set-710888.html">set()</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Static</span>&nbsp;Sets a session variable</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-start-743063.html">start()</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Static</span>&nbsp;Starts a session</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-terminate-363638.html">terminate()</a></td>
	<td nowrap="nowrap" style="width: 100%"><span class="tag">Static</span>&nbsp;Terminates a session</td>
</tr>
</table>
	</div>
</div>







<h2><span>See also</span></h2>
<div class="box edge-title">
	<div class="inner">
		<ul>
			
			<li><a href="./classes.html">List of classes</a></li>
			<li><a href="./index.html">Table of contents</a></li>
		</ul>
	</div>
</div>

		<p>
			<em>Generated by Tuxxedo Engine 1.2.0 "Beloved" Release Candidate 2 (experimental). </em>
		</p>
	</body>
</html>